<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Build Force Tomcat Maven Plugin - Plugin Documentation</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Build Force Tomcat Maven Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2009-11-22
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="usage.html">Usage</a>
          </li>
              
    <li class="none">
                    <a href="apidocs/index.html">Javadoc</a>
          </li>
              
    <li class="none">
                    <a href="faq.html">FAQ</a>
          </li>
          </ul>
              <h5>Goals</h5>
            <ul>
              
    <li class="none">
              <strong>Overview of Goals</strong>
        </li>
              
    <li class="none">
                    <a href="examples/management.html">Management Goals</a>
          </li>
              
    <li class="none">
                    <a href="examples/deployment.html">Deployment Goals</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
            
            
      
              
            <li class="expanded">
                    <a href="project-reports.html">Project Reports</a>
                  <ul>
                  
    <li class="none">
                    <a href="checkstyle.html">Checkstyle</a>
          </li>
                  
    <li class="none">
                    <a href="cobertura/index.html">Cobertura Test Coverage</a>
          </li>
                  
    <li class="none">
                    <a href="overview.html">Dependency Overview</a>
          </li>
                  
    <li class="none">
                    <a href="findbugs.html">FindBugs Report</a>
          </li>
                  
    <li class="none">
                    <a href="apidocs/index.html">JavaDocs</a>
          </li>
                  
    <li class="none">
                    <a href="jdepend-report.html">JDepend</a>
          </li>
                  
    <li class="none">
              <strong>Plugin Documentation</strong>
        </li>
                  
    <li class="none">
                    <a href="testapidocs/index.html">Test JavaDocs</a>
          </li>
              </ul>
        </li>
          </ul>
                                                 
                        
                        
            <a href="../../" title="Google Code" class="poweredBy">
                            <img alt="Google Code" src="images/code_logo.png" />
            </a>
                                
                        
                        
            <a href="http://maven.apache.org/" title="Maven" class="poweredBy">
                            <img alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
            </a>
                               
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <a name="Plugin_Documentation"></a><div class="section"><h2>Plugin Documentation</h2>
<p>Goals available for this plugin:</p>
<table class="bodyTable"><tr class="a"><th>Goal</th>
<th>Description</th>
</tr>
<tr class="b"><td><a href="clean-mojo.html">tomcat:clean</a></td>
<td>Performs a Tomcat cleanup. This includes logs/**, temp/**, work/**.</td>
</tr>
<tr class="a"><td><a href="clean-all-mojo.html">tomcat:clean-all</a></td>
<td>Performs a complete Tomcat cleanup. This includes logs/**, temp/**,
work/** as well as a complete wipe of webapps.</td>
</tr>
<tr class="b"><td><a href="copy-web-resources-mojo.html">tomcat:copy-web-resources</a></td>
<td>Copies web resources without restarting Tomcat, unless
containsWebInfResources has been set to true. This goal should be
used for quick deployment of web resources.</td>
</tr>
<tr class="a"><td><a href="copy-webapp-resources-mojo.html">tomcat:copy-webapp-resources</a></td>
<td>Stops Tomcat, copies the web resources (including WEB-INF related
ones) and re-launches Tomcat.</td>
</tr>
<tr class="b"><td><a href="deploy-jars-mojo.html">tomcat:deploy-jars</a></td>
<td>Copies all produced jars located in the target directory, excluding
*javadoc*.jar.</td>
</tr>
<tr class="a"><td><a href="deploy-war-mojo.html">tomcat:deploy-war</a></td>
<td>Copies all produced jars located in the target directory, excluding
*javadoc*.jar.</td>
</tr>
<tr class="b"><td><a href="restart-mojo.html">tomcat:restart</a></td>
<td>Restarts Tomcat.</td>
</tr>
<tr class="a"><td><a href="start-mojo.html">tomcat:start</a></td>
<td>Starts Tomcat.</td>
</tr>
<tr class="b"><td><a href="stop-mojo.html">tomcat:stop</a></td>
<td>Stops Tomcat.</td>
</tr>
</table>
<a name="System_Requirements"></a><div class="section"><h3>System Requirements</h3>
<p>The following specifies the minimum requirements to run this Maven plugin:</p>
<table class="bodyTable"><tr class="a"><td>Maven</td>
<td>2.0</td>
</tr>
<tr class="b"><td>JDK</td>
<td>1.5</td>
</tr>
<tr class="a"><td>Memory</td>
<td>No minimum requirement.</td>
</tr>
<tr class="b"><td>Disk Space</td>
<td>No minimum requirement.</td>
</tr>
</table>
</div>
<a name="Usage"></a><div class="section"><h3>Usage</h3>
<p>You should specify the version in your project's plugin configuration:</p>
<div class="source"><pre>&lt;project&gt;
  ...
  &lt;build&gt;
    &lt;!-- To define the plugin version in your parent POM --&gt;
    &lt;pluginManagement&gt;
      &lt;plugins&gt;
        &lt;plugin&gt;
          &lt;groupId&gt;org.buildforce&lt;/groupId&gt;
          &lt;artifactId&gt;tomcat-plugin&lt;/artifactId&gt;
          &lt;version&gt;1.0.0&lt;/version&gt;
        &lt;/plugin&gt;
        ...
      &lt;/plugins&gt;
    &lt;/pluginManagement&gt;
    &lt;!-- To use the plugin goals in your POM or parent POM --&gt;
    &lt;plugins&gt;
      &lt;plugin&gt;
        &lt;groupId&gt;org.buildforce&lt;/groupId&gt;
        &lt;artifactId&gt;tomcat-plugin&lt;/artifactId&gt;
        &lt;version&gt;1.0.0&lt;/version&gt;
      &lt;/plugin&gt;
      ...
    &lt;/plugins&gt;
  &lt;/build&gt;
  ...
&lt;/project&gt;
</pre>
</div>
<p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">&quot;Guide to Configuring Plug-ins&quot;</a></p>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2009
    
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
